-
Notifications
You must be signed in to change notification settings - Fork 256
/
ICommunicationClientFactory`1.xml
187 lines (185 loc) · 18.6 KB
/
ICommunicationClientFactory`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<Type Name="ICommunicationClientFactory<TCommunicationClient>" FullName="Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory<TCommunicationClient>">
<TypeSignature Language="C#" Value="public interface ICommunicationClientFactory<TCommunicationClient> where TCommunicationClient : ICommunicationClient" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ICommunicationClientFactory`1<(class Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient) TCommunicationClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1" />
<TypeSignature Language="VB.NET" Value="Public Interface ICommunicationClientFactory(Of TCommunicationClient)" />
<TypeSignature Language="F#" Value="type ICommunicationClientFactory<'CommunicationClient (requires 'CommunicationClient :> ICommunicationClient)> = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TCommunicationClient">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Interfaces />
<Docs>
<typeparam name="TCommunicationClient">Type of communication client</typeparam>
<summary>
Defines the interface that must be implemented to provide a factory for communication clients to talk to a service fabric service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ClientConnected">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>> ClientConnected;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs`1<!TCommunicationClient>> ClientConnected" />
<MemberSignature Language="DocId" Value="E:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ClientConnected" />
<MemberSignature Language="VB.NET" Value="Event ClientConnected As EventHandler(Of CommunicationClientEventArgs(Of TCommunicationClient)) " />
<MemberSignature Language="F#" Value="member this.ClientConnected : EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " Usage="member this.ClientConnected : System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Event handler that is fired when the Communication client connects to the service endpoint.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientDisconnected">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>> ClientDisconnected;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs`1<!TCommunicationClient>> ClientDisconnected" />
<MemberSignature Language="DocId" Value="E:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ClientDisconnected" />
<MemberSignature Language="VB.NET" Value="Event ClientDisconnected As EventHandler(Of CommunicationClientEventArgs(Of TCommunicationClient)) " />
<MemberSignature Language="F#" Value="member this.ClientDisconnected : EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " Usage="member this.ClientDisconnected : System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<'CommunicationClient>> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.ServiceFabric.Services.Communication.Client.CommunicationClientEventArgs<TCommunicationClient>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Event handler that is fired when the Communication client disconnects from the service endpoint.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClientAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<TCommunicationClient> GetClientAsync (System.Fabric.ResolvedServicePartition previousRsp, Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TCommunicationClient> GetClientAsync(class System.Fabric.ResolvedServicePartition previousRsp, valuetype Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.GetClientAsync(System.Fabric.ResolvedServicePartition,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClientAsync (previousRsp As ResolvedServicePartition, targetReplicaSelector As TargetReplicaSelector, listenerName As String, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member GetClientAsync : System.Fabric.ResolvedServicePartition * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="iCommunicationClientFactory.GetClientAsync (previousRsp, targetReplicaSelector, listenerName, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TCommunicationClient></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="previousRsp" Type="System.Fabric.ResolvedServicePartition" />
<Parameter Name="targetReplicaSelector" Type="Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector" />
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="previousRsp">Previous ResolvedServicePartition value</param>
<param name="targetReplicaSelector">Specifies which replica in the partition identified by the partition key, the client should connect to</param>
<param name="listenerName">Specifies which listener in the endpoint of the chosen replica, to which the client should connect to</param>
<param name="retrySettings">Specifies the retry policy that should be used for exceptions that occur when creating the client.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Re-resolves a partition of the specified service containing one or more communication listeners and returns a client to communicate
to the endpoint corresponding to the given listenerName.
The endpoint of the service is of the form - {"Endpoints":{"Listener1":"Endpoint1","Listener2":"Endpoint2" ...}}
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
the CommunicationClient(<see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient" />) object.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClientAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<TCommunicationClient> GetClientAsync (Uri serviceUri, Microsoft.ServiceFabric.Services.Client.ServicePartitionKey partitionKey, Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TCommunicationClient> GetClientAsync(class System.Uri serviceUri, class Microsoft.ServiceFabric.Services.Client.ServicePartitionKey partitionKey, valuetype Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector targetReplicaSelector, string listenerName, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.GetClientAsync(System.Uri,Microsoft.ServiceFabric.Services.Client.ServicePartitionKey,Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector,System.String,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetClientAsync (serviceUri As Uri, partitionKey As ServicePartitionKey, targetReplicaSelector As TargetReplicaSelector, listenerName As String, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of TCommunicationClient)" />
<MemberSignature Language="F#" Value="abstract member GetClientAsync : Uri * Microsoft.ServiceFabric.Services.Client.ServicePartitionKey * Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector * string * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'CommunicationClient (requires 'CommunicationClient :> Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient)>" Usage="iCommunicationClientFactory.GetClientAsync (serviceUri, partitionKey, targetReplicaSelector, listenerName, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TCommunicationClient></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="partitionKey" Type="Microsoft.ServiceFabric.Services.Client.ServicePartitionKey" />
<Parameter Name="targetReplicaSelector" Type="Microsoft.ServiceFabric.Services.Communication.Client.TargetReplicaSelector" />
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="serviceUri">Uri of the service to resolve</param>
<param name="partitionKey">Key that identifies the partition to resolve</param>
<param name="targetReplicaSelector">Specifies which replica in the partition identified by the partition key, the client should connect to</param>
<param name="listenerName">Specifies which listener in the endpoint of the chosen replica, to which the client should connect to</param>
<param name="retrySettings">Specifies the retry policy that should be used for exceptions that occur when creating the client.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Resolves a partition of the specified service containing one or more communication listeners and returns a client to communicate
to the endpoint corresponding to the given listenerName.
The endpoint of the service is of the form - {"Endpoints":{"Listener1":"Endpoint1","Listener2":"Endpoint2" ...}}
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
the CommunicationClient(<see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClient" />) object.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReportOperationExceptionAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl> ReportOperationExceptionAsync (TCommunicationClient client, Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation exceptionInformation, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl> ReportOperationExceptionAsync(!TCommunicationClient client, class Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation exceptionInformation, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.ICommunicationClientFactory`1.ReportOperationExceptionAsync(`0,Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation,Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ReportOperationExceptionAsync (client As TCommunicationClient, exceptionInformation As ExceptionInformation, retrySettings As OperationRetrySettings, cancellationToken As CancellationToken) As Task(Of OperationRetryControl)" />
<MemberSignature Language="F#" Value="abstract member ReportOperationExceptionAsync : 'CommunicationClient * Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl>" Usage="iCommunicationClientFactory.ReportOperationExceptionAsync (client, exceptionInformation, retrySettings, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="TCommunicationClient" />
<Parameter Name="exceptionInformation" Type="Microsoft.ServiceFabric.Services.Communication.Client.ExceptionInformation" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="client">Communication client</param>
<param name="exceptionInformation">Information about exception that happened while communicating with the service.</param>
<param name="retrySettings">Specifies the retry policy that should be used for handling the reported exception.</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Handles the exceptions that occur in the CommunicationClient when sending a message to the Service
</summary>
<returns>
A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding operation. The result of the Task is
a <see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.OperationRetryControl" /> object that provides information on retry policy for this exception.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>